<?php
//
//  INDEX PAGE
//

require_once('header.php');

$pub = $session->publication;
view($pub);
?>

    
    
    <section>
	    <div class="table-frame padding">
	        <h1>Help Documentation</h1>
            <hr>
            
            <article class="padding">
                
                    <h2><a href="<?php echo $Controller->page_url('subscriptions'); ?>">Subscriptions</a></h2>
                    <img class="fancy" src="images/help/subscriptions-page-1.jpg">
                    <p>
                        The <a href="<?php echo $Controller->page_url('subscriptions'); ?>"><strong>Subscriptions</strong></a> page is the main view for all your subscriptions. From the tabs across the top of the window you can Filter and Search subscriptions to find what you're looking for. Please see the Searching section for more details.
                    </p>
                    <p>
                        Each Subscription will have an entry in the list so long as it matches the Filter tab you have selected, or the search you have performed. Subbear does not readily show Inactive subscriptions, however you can search for them. 
                    </p>
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Searching</a></h4>
                            <article class="padding accordion-content">
                                <p>
                                    You can perform searches in multiple areas of the site.
                                    <ul>
                                        <li><strong>Subscription List:</strong> The <strong>Find on Page</strong> box will filter the subscription list by display name.</li>
                                        <li><strong>Search / Advanced Search:</strong> Enter your search, or expand the <strong>Advanced Search</strong> area to query the database for granular parameters. </li>
                                    </ul>
                                </p>
                            </article>
                        </div>
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Advanced Searching</a></h4>
                            <article class="padding accordion-content">
                                <img class="fancy" src="images/help/search-page-1.jpg">
                                <p>
                                    Advanced Searches allow a greater granularity when searching for subscriptions. You can search by Name, Region, Start and End Date Ranges, and by Subscription Status. Intelligent searches can be a powerful tool.
                                </p>
                            </article>
                        </div>
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Adding a subscription</a></h4>
                            <article class="padding accordion-content">
                                <img class="fancy" src="images/help/subscriptions-page-7.jpg">
                                <p>
                                    A user may only have <strong>one active subscription</strong>. You can extend, shorten or pause a subscription by adding <strong>Allowances</strong>. You can create a new subscription if a user does not currently have an active subscription.
                                </p>
                                <p>
                                    To add a new subscription, you can have two options:
                                    <ul>
                                        <li><strong>New User</strong>: see the <strong>Adding a new user</strong> section. Then, simply select a <strong>Start Date</strong> and <strong>Duration</strong>.</li>
                                        <li>
                                            <strong>Existing User</strong>:
                                            <ul>
                                                <li>Find the user in the <strong>USERS</strong> > <strong>Unsubscribed Users</strong> list.</li>
                                                <li>Search for the user name.</li>
                                                <li>Open the edit window, and select the unsubscribed user from the <strong>Create New From Existing Unsubscribed User</strong> dropdown box.</li>
                                                <li>Then, simply select a <strong>Start Date</strong> and <strong>Duration</strong>.</li>
                                            </ul>
                                        </li>
                                    </ul>
                                </p>
                                
                                <ul class="warnings">
                                   <li><strong>You can only create new subscriptions if the user is currently unsubscribed.</strong></li>
                                </ul>
                            </article>
                        </div>
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Editing a Subscription</a></h4>
                            <article class="padding accordion-content">
                                <img class="fancy" src="images/help/subscriptions-page-2.jpg">
                                <p>
                                    Editing a User with a Subscription opens up the complete controls for editing the User and their Subscription. You can proceed to make updates to the User's Address or Contact Info, or make updates to their subscription.
                                </p>
                                <p>
                                    At the top of the Edit window is a Summary of this User's status. Active, Paused, Expiring and Expired Summaries will be coloured differently to help identify their statuses.
                                </p>
                                <p> The Edit User area, titled with their name, is where you can edit their personal details.</p>
                                <p> The active Subscriptions Area shows this users subscription history, and current subscription (if any). This area is where you can edit the parameters of their subscription, expand the <strong>edit controls</strong> to quickly add or remove time, and expand the <strong>Add New Allowance</strong> controls to give yourself greater control over their subscription.</p>
                                
                            </article>
                        </div>
                        
                        
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Adding/removing time from a subscription</a></h4>
                            <article class="padding accordion-content">
                                <img class="fancy" src="images/help/subscriptions-page-3.jpg">
                                <p>
                                    Open the subscription for editing. You will notice the <strong>Active Subscriptions</strong> box, which will list all subsriptions (even old ones) for this user. Adding and subtracting time can only happen on the currently active subscription. Expand the <strong>Add New Allowance</strong> area, and select <strong>Add Time</strong> or <strong>Remove Time</strong>. You can now select the number of weeks to add or remove - or, you can add bulk time, like 1 year, 2 years or 3 years. Remember to save.
                                </p>
                                <ul class="warnings">
                                   <li><strong>You cannot remove more time than the Subscription has remaining, however you can zero-out an existing subscription.</strong></li>
                                   <li><strong>You cannot add more than 5 years of time to a Subscription.</strong></li>
                                   <li><strong>When deleting allowances remember that they cascade - meaning if you remove an allowance between other allowances they will re-shuffle to fill the gap. Be careful that you intelligently manipulate your allowances, and ensure that your subscriber is not being shortchanged.</strong></li>
                                </ul>
                            </article>
                        </div>
                        
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Set a subscription's expiry date</a></h4>
                            <article class="padding accordion-content">
                                <img class="fancy" src="images/help/subscriptions-page-5.jpg">
                                <p>
                                    Open the subscription for editing. You will notice the <strong>Active Subscriptions</strong> box, which will list the past and current subsriptions for this user.
                                </p>
                                <p>
                                    Expand the <strong>Add New Allowance</strong>, and select <strong>Set End Date</strong>. Select the final week that this user will be subscribed for.
                                </p>
                            </article>
                        </div>
                        
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Pause a subscription</a></h4>
                            <article class="padding accordion-content">
                                <img class="fancy" src="images/help/subscriptions-page-4.jpg">
                                <p>
                                    Open the subscription for editing. You will notice the <strong>Active Subscriptions</strong> box, which will list the past and current subsriptions for this user.
                                </p>
                                <p>
                                    Expand the <strong>Add New Allowance</strong> tab, and select <strong>Add Pause</strong>. You can add a pause at any time from now to the end of their subscription. To do so, select the date, and input the desired number of weeks to pause.
                                </p>
                            </article>
                        </div>
                        
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Advanced subscription editing</a></h4>
                            <article class="padding accordion-content">
                                <img class="fancy" src="images/help/subscriptions-page-6.jpg">
                                <p>
                                    Open the subscription for editing. You will notice the <strong>Active Subscriptions</strong> box, which will list the past and current subsriptions for this user.
                                </p>
                                <p>
                                    Below this, you will see a list of all <strong>Allowances</strong> for this subscription. An <strong>Allowance</strong> is a measure of time, and can be either Add or Pause. Each <strong>Allowance</strong> has details like Duration, Start and End time, as well as a record of when they were added. 
                                    You can edit individual <strong>Allowances</strong> by expanding the <strong>Edit Controls</strong>. Inserting a positive integer will add to this allowance (whether it is a Pause or Add does not matter), while a negative integer will remove time.
                                </p>
                                <ul class="warnings">
                                   <li><strong>You cannot remove more time than the Subscription has remaining, however you can remove all remainging time. This will set the Subscription to inactive.</strong></li>
                                   <li><strong>When deleting allowances remember that they cascade - meaning if you remove an allowance between other allowances they will re-shuffle to fill the gap. Be careful that you intelligently manipulate your allowances.</strong></li>
                                </ul>
                            </article>
                        </div>
                

                    <h2 class="margin-top-ultra"><a href="<?php echo $Controller->page_url('edit'); ?>">Users</a></h2>
                    <img class="fancy" src="images/help/edit-page-1.jpg">
                    <p>
                        The <a href="<?php echo $Controller->page_url('edit'); ?>"><strong>Users</strong></a> page is the main view for managing the users, or subscribers, of your publication. From this page you can Create/Edit new users, Create/Edit new subscriptions, and View users without subscriptions. Please see the Searching section for more details on performing searches.
                    </p>
                    
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Adding a new user</a></h4>
                            <article class="padding accordion-content">
                                <p>
                                    A user - or subscriber - can be created by clicking the <strong>USERS</strong> menu item at the top, or by clicking <strong>New Subscription</strong> in the subscriptions list.
                                </p>
                                <p>
                                   You will be prompted with a new user form, which when correctly filled in and saved, will create a new user in your database. 
                                </p>
                                
                                <ul class="warnings">
                                   <li><strong>Please pay close attention to spelling and punctuation, both of which can severly affect sorting. Consistency is key.</strong></li>
                                   <li><strong>It is best not to delete a user, they may want to subscribe again in the future, and keeping records of their past subscriptions may be important for you.</strong></li>
                                </ul>
                            </article>
                        </div>
                        
                        <div class="accordion-item">
                            <h4 class="accordion-title"><a href="#">Editing a user</a></h4>
                            <article class="padding accordion-content">
                                <p>
                                    Editing a user is just as simple as creating a user. Locate the entry which you want to edit, open it, make your corrections, and re-save the user.
                                </p>
                                <ul class="warnings">
                                   <li><strong>The edit window will look different for subscribed and unsubscribed users. This is normal; a subscribed user has a lot more options!</strong></li>
                                   <li><strong>It is best not to delete a user, they may want to subscribe again in the future, and keeping records of their past subscriptions may be important for you.</strong></li>
                                </ul>
                            </article>
                        </div>
                        
                        
                        
        
                    <h2 class="margin-top-ultra"><a href="<?php echo $Controller->page_url('reports'); ?>">Reports</a></h2>
                    <img class="fancy" src="images/help/reports-page-1.jpg">
                    <p>
                        The <a href="<?php echo $Controller->page_url('reports'); ?>"><strong>Reports</strong></a> page is where you can find and download reports, as well as generate new ones. There are 6 main actions you can perform:
                        <ul>
                            <li><strong>Mailing Labels:</strong> Clicking this will generate a new spreadsheet with the mailing labels for the CURRENT week. This will include all subscriptions who are scheduled to receve their issue. It will not include Expired or Paused subscriptions - however, recently expired subscriptions still within the Grace Perion will still receive their issue.</li>
                            <li><strong>Expired Labels:</strong> Clicking this will generate a new spreadsheet with only your expired subscribers; handy if you are going to direct mail a re-subscription form.</li>
                            <li><strong>Subscription Report:</strong> A general report with your overall subscription information. Handy for your own personal knowledge, or to share your list with others.</li>
                            <li><strong>Expiring/Expired Report:</strong> A general report outlining your expiring or expired subscriptions.</li>
                            <li><strong>Totals Report:</strong> A tally of your subscription totals based on regions and your Local Towns setting.</li>
                            <li><strong>SCRUB:</strong> A very important action, SCRUBBING will individually verify and correct any subscription errors in your database. It is particularly useful to run this after significant updates to your database. SCRUBBING happens once a day automatically.</li>
                        </ul>
                    </p>

                    <h2 class="margin-top-ultra"><a href="<?php echo $Controller->page_url('publication'); ?>">Publication Settings</a></h2>
                    <img class="fancy" src="images/help/publication-page-1.jpg">
                    <p>
                        The <a href="<?php echo $Controller->page_url('publication'); ?>"><strong>Publication settings</strong></a> can be accessed by the 'gear' in the top right hand corner. This will give you access to some settings that will affect the <strong>Subscription Management System</strong> in several ways:
                        
                    </p>
                    <ul>
                        <li><strong>Publication Day:</strong> This setting will change the day of the week when a subscription counter ticks forward. Changing it may take a few seconds to a few minutes while all subscriptions are updated.</li>
                        <li><strong>Local Towns:</strong> A Comma Separated List of towns which are of interest. These towns will receive their own subscription counter.  Please ensure consistency in spelling and punctuation.</li>
                        <li><strong>Records Per Page:</strong> The number of subscriptions to show on the <strong>Subscriptions</strong> list. A higher number will take longer to load.</li>
                        <li><strong>Notify me of Expiring Subscriptions X Weeks Before:</strong> The week tolerance for when a subscription will be considered <strong>Expiring</strong>.</li>
                        <li><strong>Subscription Grace Period:</strong> The week tolerance for when a subscription will not longer appear in your labelling once <strong>Expired</strong>.</li>
                        <li><strong>Sort Order:</strong> The order by which you prefer your Mailing Labels to be ordered, Left to Right.</li>
                    </ul>
             
 
            
            
            </article>
	    </div>
	</section>
	
<?php
//
//  End page.
//
require_once('footer.php');
?>




